Skip to content

Docs: name the application roles by decision 0234 - #5

Merged
immakermatty merged 1 commit into
mainfrom
agent/LZD-0009-slovnik-0234
Nov 8, 2026
Merged

immakermatty merged 1 commit into
mainfrom
agent/LZD-0009-slovnik-0234

Conversation

@immakermatty

Copy link
Copy Markdown
Contributor

Status: ready for review

What changed

Decision 0234 gives every access role one English name that always names its level. This PR carries it through the module kit's current documentation and doc comments:

  • README.md, "Who came and with which role": "application admin or application user" becomes Application Admin or Application User, with one sentence mapping them to the stable appRole values. "The Environment's assignee" becomes the Environment's Assigned User. "The two roles" becomes the two application roles. The Python paragraph says app_role takes the same values.
  • src/index.ts: the AppAccess doc comment says Application Admin and maps appRole to the names.
  • python/src/lazurio_module_kit/__init__.py: the AppAccess docstring does the same for app_role.
  • test/index.test.ts: one test title and one comment use the same names.
  • proof/gateway.ts: one comment puts admin in backticks because it is a value.

Identifier mapping documented

0234 name Stable value (unchanged)
Application Admin appRole: "admin" / app_role == "admin" / X-Lazurio-App-Role: admin
Application User appRole: "user" / app_role == "user" / X-Lazurio-App-Role: user

No appAccess field, value, header, type or behaviour changes. The appAccess v1 contract stays as it is.

Deliberate leftovers

  • The values "admin" and "user" and the header X-Lazurio-App-Role keep their spelling: they are the stable contract.
  • admin-api in the tests is a listener id, not a role.
  • Caddy's admin off in proof/gateway.ts is Caddy's admin endpoint, not a role.
  • The PASS line and progress messages of proof/gateway.ts print environment/admin, which are the values.

Verification

  • bun install --frozen-lockfile, bun run check (tsc and Biome): pass.
  • bun test: 64 pass, 0 fail. The "close failed" log line is the expected error from the "exits 1 when fn throws" test.
  • Python (python/): uv sync --frozen, ruff format --check, ruff check, pyright and pytest -q (64 passed) all pass.
  • git diff --check: clean.
  • bun proof/gateway.ts was not run. It needs Caddy, OpenSSL and a Machines checkout, and this change touches only comments and docs.

Agent: environment a480495c-25e0-4e51-828b-1dbf1b77d62f · T3 thread b546b092-bf41-4183-a54b-7a5f3dc4fd73

🤖 Generated with Claude Code

The README "Who came and with which role" section and the doc comments
of appAccess / AppAccess (TypeScript and Python) now say Application
Admin and Application User instead of a lowercase "application admin" or
a bare "user", and map them once to the stable appRole / app_role values
"admin" and "user", which do not change. "The Environment's assignee"
becomes the Environment's Assigned User. One test title and one test
comment follow the same names. No code, field, value or header changes.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@immakermatty immakermatty self-assigned this Nov 8, 2026

@agentrozjedemeai agentrozjedemeai left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bez blokujících nálezů. Názvy a mapování odpovídají rozhodnutí 0234; kontroly TypeScriptu prošly místně a kontroly Pythonu i TypeScriptu prošly v CI na tomto commitu. Python lokálně neověřen: uv není v Prostředí dostupné.

— Pablo

@immakermatty
immakermatty merged commit d13dd44 into main Nov 8, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants